Operation: HA Configuration-HA Settings
Description: Configure High Availability. It is a feature wherein two appliances are grouped together in a cluster and instructed to work as a single entity. 

Sample Configuration
<HA> <HAConfigure> <!--ApplianceKey is readonly purpose --> <HAConfiguration>EnableHA</HAConfiguration> <!-- IF HAConfiguration is EnableHA then all below options are required. --> <ApplianceKey>C017204597-AB5DQ6</ApplianceKey> <PeerApplianceKey>C017204597-AB5DQ6</PeerApplianceKey> <HAConfigurationMode>Active-Active/Active-Passive</HAConfigurationMode> <DedicatedHALinkPort>PortC</DedicatedHALinkPort> <PeerHALinkIP>1.1.1.1</PeerHALinkIP> <PeerAdministrationPort>PortA</PeerAdministrationPort> <PeerAdministrationIP>1.1.1.1</PeerAdministrationIP> <PeerAdministrationIPV6>1122::1211</PeerAdministrationIPV6> <MonitoredPorts> <Port>Number</Port> : </MonitoredPorts> </HAConfigure> <DisableHA>actionidentificationtagnodata</DisableHA> <!-- this tag is just a event indication --> </HA>



Parameter Mandatory Default Description
HAConfigurationModeYes  
Select configuration mode for the cluster from the available options: Active-Active OR Active-Passive.
HAConfigurationMode confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
PortNo  
Select the port for Heartbeat Link using which both Appliances in HA would monitor each other.
Port confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
PeerAdministrationIPYes  
Specify Administration IP Address for Auxiliary Appliance using which the Admin Console of Auxiliary Appliance can be accessed.
PeerAdministrationIP confines to:
  • Type is 'SCALAR'.
  • Datatype is 'IPADDRESS'.
  • Maximum characters allowed are 30.
  • IP Class other than 'MULTICAST', 'RESERVED', 'LOCALHOST', 'UNSPECIFIED', 'BROADCAST', 'LINKLOCAL' is allowed.
PeerAdministrationPortYes  
Specify Administration Port for Auxiliary Appliance.
PeerAdministrationPort confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
PortNo  
Select the ports to be monitored and in case any port goes down, the appliance will leave cluster.
Port confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
DedicatedHALinkPortYes  
Specify HA link port through which the two appliances are physically connected.
DedicatedHALinkPort confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
PeerHALinkIPYes  
Specify IP Address configured on the HA link port of the peer appliance.
PeerHALinkIP confines to:
  • Type is 'SCALAR'.
  • Datatype is 'IPADDRESS'.
  • Maximum characters allowed are 30.
  • IP Class other than 'MULTICAST', 'RESERVED', 'LOCALHOST', 'UNSPECIFIED', 'BROADCAST', 'LINKLOCAL' is allowed.
EncryptionKeyYes  
Specify 'encryptionkey'
EncryptionKey confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.
  • Maximum characters allowed are 16.
  • Minimum characters allowed are 8.
PeerAdministrationIPV6No  
Specify 'peeraccessipv6'
PeerAdministrationIPV6 confines to:
  • Type is 'SCALAR'.
  • Datatype is 'STRING'.



Operation   Status   Message
HA Configuration-HA Settings200
HA Configuration-HA Settings211
HA Configuration-HA Settings216
HA Configuration-HA Settings500
HA Configuration-HA Settings502
HA Configuration-HA Settings504
HA Configuration-HA Settings505
HA Configuration-HA Settings541
HA Configuration-HA Settings542
HA Configuration-HA Settings543
HA Configuration-HA Settings544
HA Configuration-HA Settings545
HA Configuration-HA Settings546
HA Configuration-HA Settings547
HA Configuration-HA Settings548
HA Configuration-HA Settings549
HA Configuration-HA Settings550
HA Configuration-HA Settings551
HA Configuration-HA Settings554

) Copyright 2017 Sophos Limited. All rights reserved.
Sophos is registered trademarks of Sophos Limited and Sophos Group. All other product and company names mentioned are trademarks or registered trademarks of their respective owners.
No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording or otherwise unless you are either a valid licensee where the documentation can be reproduced in accordance with the license terms or you otherwise have the prior permission in writing of the copyright owner.